home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cgesdd.z / cgesdd
Encoding:
Text File  |  2002-10-03  |  7.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGEEEESSSSDDDDDDDD((((3333SSSS))))                                                          CCCCGGGGEEEESSSSDDDDDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGESDD - compute the singular value decomposition (SVD) of a complex M-
  10.      by-N matrix A, optionally computing the left and/or right singular
  11.      vectors, by using divide-and-conquer method
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CGESDD( JOBZ, M, N, A, LDA, S, U, LDU, VT, LDVT, WORK, LWORK,
  15.                         RWORK, IWORK, INFO )
  16.  
  17.          CHARACTER      JOBZ
  18.  
  19.          INTEGER        INFO, LDA, LDU, LDVT, LWORK, M, N
  20.  
  21.          INTEGER        IWORK( * )
  22.  
  23.          REAL           RWORK( * ), S( * )
  24.  
  25.          COMPLEX        A( LDA, * ), U( LDU, * ), VT( LDVT, * ), WORK( * )
  26.  
  27. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  28.      These routines are part of the SCSL Scientific Library and can be loaded
  29.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  30.      directs the linker to use the multi-processor version of the library.
  31.  
  32.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  33.      4 bytes (32 bits). Another version of SCSL is available in which integers
  34.      are 8 bytes (64 bits).  This version allows the user access to larger
  35.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  36.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  37.      only one of the two versions; 4-byte integer and 8-byte integer library
  38.      calls cannot be mixed.
  39.  
  40. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  41.      CGESDD computes the singular value decomposition (SVD) of a complex M-
  42.      by-N matrix A, optionally computing the left and/or right singular
  43.      vectors, by using divide-and-conquer method. The SVD is written
  44.           A = U * SIGMA * conjugate-transpose(V)
  45.  
  46.      where SIGMA is an M-by-N matrix which is zero except for its min(m,n)
  47.      diagonal elements, U is an M-by-M unitary matrix, and V is an N-by-N
  48.      unitary matrix.  The diagonal elements of SIGMA are the singular values
  49.      of A; they are real and non-negative, and are returned in descending
  50.      order.  The first min(m,n) columns of U and V are the left and right
  51.      singular vectors of A.
  52.  
  53.      Note that the routine returns VT = V**H, not V.
  54.  
  55.      The divide and conquer algorithm makes very mild assumptions about
  56.      floating point arithmetic. It will work on machines with a guard digit in
  57.      add/subtract, or on those binary machines without guard digits which
  58.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  59.      conceivably fail on hexadecimal or decimal machines without guard digits,
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGEEEESSSSDDDDDDDD((((3333SSSS))))                                                          CCCCGGGGEEEESSSSDDDDDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      but we know of none.
  75.  
  76.  
  77. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  78.      JOBZ    (input) CHARACTER*1
  79.              Specifies options for computing all or part of the matrix U:
  80.              = 'A':  all M columns of U and all N rows of V**H are returned in
  81.              the arrays U and VT; = 'S':  the first min(M,N) columns of U and
  82.              the first min(M,N) rows of V**H are returned in the arrays U and
  83.              VT; = 'O':  If M >= N, the first N columns of U are overwritten
  84.              on the array A and all rows of V**H are returned in the array VT;
  85.              otherwise, all columns of U are returned in the array U and the
  86.              first M rows of V**H are overwritten in the array VT; = 'N':  no
  87.              columns of U or rows of V**H are computed.
  88.  
  89.      M       (input) INTEGER
  90.              The number of rows of the input matrix A.  M >= 0.
  91.  
  92.      N       (input) INTEGER
  93.              The number of columns of the input matrix A.  N >= 0.
  94.  
  95.      A       (input/output) COMPLEX array, dimension (LDA,N)
  96.              On entry, the M-by-N matrix A.  On exit, if JOBZ = 'O',  A is
  97.              overwritten with the first N columns of U (the left singular
  98.              vectors, stored columnwise) if M >= N; A is overwritten with the
  99.              first M rows of V**H (the right singular vectors, stored rowwise)
  100.              otherwise.  if JOBZ .ne. 'O', the contents of A are destroyed.
  101.  
  102.      LDA     (input) INTEGER
  103.              The leading dimension of the array A.  LDA >= max(1,M).
  104.  
  105.      S       (output) REAL array, dimension (min(M,N))
  106.              The singular values of A, sorted so that S(i) >= S(i+1).
  107.  
  108.      U       (output) COMPLEX array, dimension (LDU,UCOL)
  109.              UCOL = M if JOBZ = 'A' or JOBZ = 'O' and M < N; UCOL = min(M,N)
  110.              if JOBZ = 'S'.  If JOBZ = 'A' or JOBZ = 'O' and M < N, U contains
  111.              the M-by-M unitary matrix U; if JOBZ = 'S', U contains the first
  112.              min(M,N) columns of U (the left singular vectors, stored
  113.              columnwise); if JOBZ = 'O' and M >= N, or JOBZ = 'N', U is not
  114.              referenced.
  115.  
  116.      LDU     (input) INTEGER
  117.              The leading dimension of the array U.  LDU >= 1; if JOBZ = 'S' or
  118.              'A' or JOBZ = 'O' and M < N, LDU >= M.
  119.  
  120.      VT      (output) COMPLEX array, dimension (LDVT,N)
  121.              If JOBZ = 'A' or JOBZ = 'O' and M >= N, VT contains the N-by-N
  122.              unitary matrix V**H; if JOBZ = 'S', VT contains the first
  123.              min(M,N) rows of V**H (the right singular vectors, stored
  124.              rowwise); if JOBZ = 'O' and M < N, or JOBZ = 'N', VT is not
  125.              referenced.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGEEEESSSSDDDDDDDD((((3333SSSS))))                                                          CCCCGGGGEEEESSSSDDDDDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LDVT    (input) INTEGER
  141.              The leading dimension of the array VT.  LDVT >= 1; if JOBZ = 'A'
  142.              or JOBZ = 'O' and M >= N, LDVT >= N; if JOBZ = 'S', LDVT >=
  143.              min(M,N).
  144.  
  145.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  146.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  147.  
  148.      LWORK   (input) INTEGER
  149.              The dimension of the array WORK. LWORK >= 1.  if JOBZ = 'N',
  150.              LWORK >= 2*min(M,N)+max(M,N).  if JOBZ = 'O', LWORK >=
  151.              2*min(M,N)*min(M,N)+2*min(M,N)+max(M,N).  if JOBZ = 'S' or 'A',
  152.              LWORK >= min(M,N)*min(M,N)+2*min(M,N)+max(M,N).  For good
  153.              performance, LWORK should generally be larger.  If LWORK < 0 but
  154.              other input arguments are legal, WORK(1) returns the optimal
  155.              LWORK.
  156.  
  157.      RWORK   (workspace) REAL array, dimension (LRWORK)
  158.              If JOBZ = 'N', LRWORK >= 7*min(M,N).  Otherwise, LRWORK >=
  159.              5*min(M,N)*min(M,N) + 5*min(M,N)
  160.  
  161.      IWORK   (workspace) INTEGER array, dimension (8*min(M,N))
  162.  
  163.      INFO    (output) INTEGER
  164.              = 0:  successful exit.
  165.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  166.              > 0:  The updating process of SBDSDC did not converge.
  167.  
  168. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  169.      Based on contributions by
  170.         Ming Gu and Huan Ren, Computer Science Division, University of
  171.         California at Berkeley, USA
  172.  
  173.  
  174. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  175.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  176.  
  177.      This man page is available only online.
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.